home *** CD-ROM | disk | FTP | other *** search
/ PD ROM 1 / PD ROM Volume I - Macintosh Software from BMUG (1988).iso / Text / Text Tools / Pr doc < prev    next >
Encoding:
Text File  |  1986-10-10  |  5.6 KB  |  129 lines  |  [TEXT/ttxt]
  1. --------------------------------------------------------------------------
  2. PrettyPrint Notes        PrettyPrint Notes        PrettyPrint Notes
  3. --------------------------------------------------------------------------
  4.  
  5. PrettyPrint and "PrettyPrint Notes" (this document) are:
  6.  
  7. (c) 1985, 1986 HyperSoft. All Rights Reserved.
  8.  
  9. --------------------------------------------------------------------------
  10. About PrettyPrint
  11. --------------------------------------------------------------------------
  12.  
  13. This document provides a brief introduction to PrettyPrint, a text file
  14. printing utility. PrettyPrint, like many other programs which have been
  15. distributed, allows users to print text files created with any editor
  16. (including MacWrite, MDS Edit, MPW, and LightSpeedC) on the ImageWriter,
  17. ImageWriter II, or LaserWriter. Unlike all of the other programs which
  18. have been distributed, PrettyPrint can print your C and Pascal programs
  19. in a much more readable format. Files printed by PrettyPrint can have
  20. italicized comments, boldfaced keywords, and even boldfaced Macintosh trap
  21. calls.
  22.  
  23. PrettyPrint is SHAREWARE: you are free to distribute this program to
  24. your friends. Non-profit user groups may distribute this program on
  25. their disks, provided it is accompanied by this file. Bulletin boards
  26. and online services may make this program available for downloading,
  27. provided that there are no special downloading charges. However, we do ask
  28. all USERS register their copy of PrettyPrint, to help pay for development
  29. costs.
  30.  
  31. As an incentive, users who register their copy of PrettyPrint will receive
  32. a printed manual (much more extensive than this document), a copy of the
  33. latest version of PrettyPrint, and a special configuration program which
  34. lets you add your own keywords to those built into PrettyPrint. To
  35. register your copy, send $25.00 (check or money order) to:
  36.  
  37.         HyperSoft
  38.         2124 Kittredge Street #174
  39.         Berkeley CA 94704
  40.  
  41. Thank you for making shareware possible!
  42.  
  43. --------------------------------------------------------------------------
  44. How to use PrettyPrint
  45. --------------------------------------------------------------------------
  46.  
  47. PrettyPrint is fairly easy to use. There are several menus: the Apple menu,
  48. the File menu, the Edit menu, the Options Menu, the Font Menu, and the
  49. FontSize menu. The more commonly used commands have command key
  50. equivalents.
  51.  
  52. The Apple menu has an "About PrettyPrint..." item which prints some
  53. version information, and the usual desk accessories.
  54.  
  55. The File menu has two commands, the "Print..." command and the "Quit"
  56. command. The Print command allows you to select a single file to be
  57. printed. The Quit command does you-know-what.
  58.  
  59. The Edit menu works with desk accessories only. It does the things you
  60. would expect.
  61.  
  62. The Options menu contains many options which tailor PrettyPrint.
  63.  
  64.     "Print Header", allows a header to be printed at the
  65.     top of each page.
  66.  
  67.     "Set Tab Width..." sets the default tab width.
  68.  
  69.     "Use Config Resource..."  tells PrettyPrint what information
  70.     to use when printing a document. Text files created using
  71.     MDS Edit, LightSpeedC, or MPW Shell have configuration resources
  72.     stored within them which specify, among other things, the font,
  73.     font size, and tab width. PrettyPrint can read these resources,
  74.     and use the information when it prints a file. You can read just
  75.     the tab width or just the font and font size, or you can read both.
  76.     For printing on the ImageWriter, you should probably read both. On
  77.     the LaserWriter, you should just read the tab size and use the
  78.     Courier font.
  79.  
  80.     "C Pretty Printing..." enables and disables C language pretty
  81.     printing. If this command has a check mark next to it, doing
  82.     this command turns off C prettyprinting. If it doesn't have
  83.     a checkmark, doing this command will bring up a dialog which lets
  84.     you set tailor the pretty printing. To speed up pretty printing,
  85.     turn off the two boldface options.
  86.  
  87.     "Pascal Pretty Printing..." enables and disables Pascal
  88.     pretty printing. It works the same as the C Pretty Printing
  89.     command.
  90.  
  91. The Font menu allows you to select the default font.
  92.  
  93. The FontSize menu allows you to select the default font size.
  94.  
  95. All defaults are saved across invocations, so you only need to set up
  96. your favorite defaults once.
  97.  
  98. One thing to watch out for is that the C and Pascal pretty printing
  99. can get confused if you leave it on while printing plain text or a
  100. program written in a different language than the one you have selected.
  101. Be sure to change the settings to match the file you are printing.
  102.  
  103. You can print many files at once by selecting PrettyPrint and the files
  104. you would like to print and executing the Open command from the file menu.
  105. PrettyPrint will print your files and then quit.
  106.  
  107. --------------------------------------------------------------------------
  108. Bugs and Future Enhancements
  109. --------------------------------------------------------------------------
  110.  
  111.   When pretty printing, columns do not always align correctly, even with
  112.   a monospaced font. Italicicized and Bolded text takes up more space,
  113.   so some lines end up being shifted to the right.
  114.  
  115.   The LaserWriter sometimes gives up the ghost in the middle of a document,
  116.   returning a VERY strange error code. This is caused by an out of memory
  117.   condition within the LaserWriter itself. No easy fix, since the bug is
  118.   in the LaserWriter or the LaserWriter driver.
  119.  
  120.   PrettyPrint should figure out what kind of document is being printed
  121.   based on filename suffix (e.g., '.h' and '.c' are C files).
  122.  
  123.   PrettyPrint should wrap long lines around instead of just cutting them
  124.   off in midstream.
  125.  
  126. The last two items will probably be added for the next update. Any
  127. additional bug reports or suggestions are welcome.
  128.  
  129.